📖 Improve formatting on the docs website #1446

m1kola · 2024-11-12T14:58:37Z

Description

Fixes a number of formatting/rendering issues. Mostly around lists, admonitions (notes, warnings, etc) and collapsible text.

Tip

Recommend reviewing the changes with git diff --ignore-all-space (-w) option. GitHub UI also has this option.

Tip

We also have docs deployment preview. See the comment from netlify bot below.

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

netlify · 2024-11-12T14:58:54Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`c916dc7`
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/6734a3daf64a1b000848b566
😎 Deploy Preview	https://deploy-preview-1446--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

m1kola · 2024-11-12T15:02:05Z

docs/tutorials/downgrade-extension.md

-** Disable CRD Upgrade Safety Check:**
+**Command Example:**

-**Patch the ClusterExtension Resource:**
+If you prefer using the command line, you can use `kubectl` to modify the upgrade CRD safety check configuration.


This is the only text related change because it was very odd to read this.

Everything else is just formatting.

VS

codecov · 2024-11-12T15:08:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.91%. Comparing base (046c3df) to head (9f7db18).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1446   +/-   ##
=======================================
  Coverage   74.91%   74.91%           
=======================================
  Files          42       42           
  Lines        3241     3241           
=======================================
  Hits         2428     2428           
  Misses        642      642           
  Partials      171      171

Flag	Coverage Δ
e2e	`51.95% <ø> (-0.10%)`	⬇️
unit	`57.20% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

m1kola · 2024-11-12T15:11:49Z

docs/concepts/upgrade-support.md

-> [!NOTE]
-> Currently, OLM 1.0 does not support automatic upgrades to the next major version. You must manually verify and perform major version upgrades. For more information about major version upgrades, see [Manually verified upgrades and downgrades](#manually-verified-upgrades-and-downgrades).
+!!! note
+    Currently, OLM 1.0 does not support automatic upgrades to the next major version. You must manually verify and perform major version upgrades. For more information about major version upgrades, see [Manually verified upgrades and downgrades](#manually-verified-upgrades-and-downgrades).


!!! note This renders well in our mkdocs website, but not on GitHub. [!NOTE] renders well on GitHub, but not in mkdocs.

Same applies to other admonitions.

Ref: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#classic-admonitions-docsstylesheetsextracss

We are changing these admonitions in docs dir because these are docs which will be rendered on the website. Leaving everything outside of docs dir as is - these will likely be viewed via GitHub UI.

m1kola · 2024-11-12T15:13:18Z

CONTRIBUTING.md

-kind create cluster operator-controller
-```
+    ```sh
+    kind create cluster operator-controller


It was rendering fine in GH UI. However this doc is also used in the website. This formatting works fine in both GH and on the website.

docs/concepts/upgrade-support.md

camilamacedo86

Assuming that you finished (since I cannot see in the title WIP)

Hi @m1kola

The emoji here is 📖 not 🌱

🌱 is only for things that does not bring impacted to the end users at all (i.e changes in the e2e tests)

So could you please fix the emoji?

Otherwise,

I gave a look on this one with the preview and all shows fine 🥇
Great work !!! Well done

/lgtm

m1kola · 2024-11-12T16:01:58Z

Forgot we have a separate emoji for docs. Updated.

trgeiger

Requesting a few small changes

docs/concepts/upgrade-support.md

docs/contribute/developer.md

docs/howto/derive-service-account.md

docs/tutorials/upgrade-extension.md

m1kola · 2024-11-12T16:30:32Z

@trgeiger lovely stuff! Please take a look at the latest push: it addresses your feedback + I noticed a broken list under "Putting it all together" in docs/howto/derive-service-account.md

openshift-ci · 2024-11-12T20:55:44Z

@trgeiger: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

trgeiger · 2024-11-12T20:56:26Z

/lgtm

michaelryanpeter · 2024-11-12T22:08:32Z

/lgtm

openshift-ci · 2024-11-12T22:08:35Z

@michaelryanpeter: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

camilamacedo86 · 2024-11-13T07:52:05Z

/lgtm

m1kola · 2024-11-13T08:46:12Z

Had to rebase due to #1228

m1kola · 2024-11-13T11:13:59Z

Blocked by #1451. Will require another rebase once it merges.

camilamacedo86

/lgtm
/approve

Fixes a number of formatting/rendering issues. Mostly around lists, admonitions (notes, warnings, etc) and collapsible text. Signed-off-by: Mikalai Radchuk <[email protected]>

openshift-ci · 2024-11-13T13:04:27Z

New changes are detected. LGTM label has been removed.

m1kola · 2024-11-13T13:05:34Z

Rebased on top of #1451 so it can pass upgrade-e2e.

perdasilva

awesome! Thank you!!!

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 12, 2024

m1kola commented Nov 12, 2024

View reviewed changes

m1kola marked this pull request as ready for review November 12, 2024 15:04

m1kola requested a review from a team as a code owner November 12, 2024 15:04

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 12, 2024

m1kola commented Nov 12, 2024

View reviewed changes

trgeiger reviewed Nov 12, 2024

View reviewed changes

docs/concepts/upgrade-support.md Show resolved Hide resolved

m1kola force-pushed the fix_docs_rendering branch from 77c1ae7 to 859f2ba Compare November 12, 2024 15:57

m1kola requested a review from trgeiger November 12, 2024 15:58

camilamacedo86 approved these changes Nov 12, 2024

View reviewed changes

openshift-ci bot assigned camilamacedo86 Nov 12, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 12, 2024

m1kola changed the title ~~🌱 Improve formatting on the docs website~~ 📖 Improve formatting on the docs website Nov 12, 2024

trgeiger suggested changes Nov 12, 2024

View reviewed changes

docs/concepts/upgrade-support.md Show resolved Hide resolved

docs/contribute/developer.md Show resolved Hide resolved

docs/howto/derive-service-account.md Show resolved Hide resolved

docs/tutorials/upgrade-extension.md Outdated Show resolved Hide resolved

m1kola force-pushed the fix_docs_rendering branch from 859f2ba to 9f7db18 Compare November 12, 2024 16:27

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 12, 2024

m1kola requested a review from trgeiger November 12, 2024 16:27

m1kola mentioned this pull request Nov 12, 2024

📖 Fix docs: "Getting Started" and "Tutorials" #1443

Merged

7 tasks

openshift-ci bot assigned trgeiger Nov 12, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 12, 2024

trgeiger approved these changes Nov 12, 2024

View reviewed changes

m1kola force-pushed the fix_docs_rendering branch from 9f7db18 to 118b870 Compare November 13, 2024 08:45

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 13, 2024

camilamacedo86 reviewed Nov 13, 2024

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 13, 2024

Improve formatting on the docs website

c916dc7

Fixes a number of formatting/rendering issues. Mostly around lists, admonitions (notes, warnings, etc) and collapsible text. Signed-off-by: Mikalai Radchuk <[email protected]>

m1kola force-pushed the fix_docs_rendering branch from 118b870 to c916dc7 Compare November 13, 2024 13:04

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 13, 2024

m1kola enabled auto-merge November 13, 2024 13:13

perdasilva approved these changes Nov 13, 2024

View reviewed changes

m1kola added this pull request to the merge queue Nov 13, 2024

Merged via the queue into operator-framework:main with commit ac75d65 Nov 13, 2024
16 checks passed

m1kola deleted the fix_docs_rendering branch November 13, 2024 14:03

📖 Improve formatting on the docs website #1446

📖 Improve formatting on the docs website #1446

Uh oh!

Conversation

m1kola commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Reviewer Checklist

Uh oh!

netlify bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

m1kola Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

m1kola Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m1kola Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

m1kola commented Nov 12, 2024

Uh oh!

trgeiger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

m1kola commented Nov 12, 2024

Uh oh!

openshift-ci bot commented Nov 12, 2024

Uh oh!

trgeiger commented Nov 12, 2024

Uh oh!

michaelryanpeter commented Nov 12, 2024

Uh oh!

openshift-ci bot commented Nov 12, 2024

Uh oh!

camilamacedo86 commented Nov 13, 2024

Uh oh!

m1kola commented Nov 13, 2024

Uh oh!

m1kola commented Nov 13, 2024

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Nov 13, 2024

Uh oh!

m1kola commented Nov 13, 2024

Uh oh!

perdasilva left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

m1kola commented Nov 12, 2024 •

edited

Loading

netlify bot commented Nov 12, 2024 •

edited

Loading

m1kola Nov 12, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading

m1kola Nov 12, 2024 •

edited

Loading